Class VirtualTemplateManagerImpl

All Implemented Interfaces:
IPCObject, Process, VirtualTemplateManager

public class VirtualTemplateManagerImpl extends ProcessImpl implements VirtualTemplateManager
Information provided by the PKI file:

    \class VirtualTemplateManager
    
    \brief VirtualTemplateManager manages and manipulates virtual template interfaces for PPPoE.
    
    \example network().getDevice("Router0").getProcess("VirtualTemplateManager")
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • addVirtualTempIntByNum

      public VirtualTemplateInterface addVirtualTempIntByNum(int number)
      Information provided by the PKI file:
      
          \brief Adds a virtual template interface.
          
          \param number, the interface number for the virtual template interface.
          
              
      Specified by:
      addVirtualTempIntByNum in interface VirtualTemplateManager
      Parameters:
      number - Takes in a parameter of number
      Returns:
      VirtualTemplateInterface Returns a VirtualTemplateInterface
    • removeVirtualTempByNum

      public void removeVirtualTempByNum(int number)
      Information provided by the PKI file:
      
          \brief Removes the virtual template interface with the specified interface number.
          
          \param number, the interface number of the virtual template interface of interest.
          
              
      Specified by:
      removeVirtualTempByNum in interface VirtualTemplateManager
      Parameters:
      number - Takes in a parameter of number
    • getVirtualTempIntByNum

      public VirtualTemplateInterface getVirtualTempIntByNum(int number)
      Information provided by the PKI file:
      
          \brief Returns the virtual template interface with the specified interface number.
          
          \param number, the interface number of the virtual template interface of interest.
          
          \return VirtualTemplateInterface, the VirtualTemplateInterface object with the specified interface number.
          
              
      Specified by:
      getVirtualTempIntByNum in interface VirtualTemplateManager
      Parameters:
      number - Takes in a parameter of number
      Returns:
      VirtualTemplateInterface Returns a VirtualTemplateInterface
    • getIntCount

      public int getIntCount()
      Information provided by the PKI file:
      
          \brief Returns the number of virtual template interfaces.
          
          \return int, the number of virtual template interfaces.
          
              
      Specified by:
      getIntCount in interface VirtualTemplateManager
      Returns:
      int Returns a int
    • getIntAt

      public VirtualTemplateInterface getIntAt(int number)
      Information provided by the PKI file:
      
          \brief Returns the virtual template interface at the specified index.
          
          \param number, the index of the virtual template interface of interest.
          
          \return VirtualTemplateInterface, the VirtualTemplateInterface object at the specified index.
          
              
      Specified by:
      getIntAt in interface VirtualTemplateManager
      Parameters:
      number - Takes in a parameter of number
      Returns:
      VirtualTemplateInterface Returns a VirtualTemplateInterface
    • addVpdnGroupByName

      public void addVpdnGroupByName(String name)
      Information provided by the PKI file:
      
          \brief Adds a VPDN group.
          
          \param name, the name for the VPDN group.
          
              
      Specified by:
      addVpdnGroupByName in interface VirtualTemplateManager
      Parameters:
      name - Takes in a parameter of name
    • removeVpdnGroupByName

      public void removeVpdnGroupByName(String name)
      Information provided by the PKI file:
      
          \brief Removes the VPDN group with the specified name.
          
          \param name, the name of the VPDN group of interest.
          
              
      Specified by:
      removeVpdnGroupByName in interface VirtualTemplateManager
      Parameters:
      name - Takes in a parameter of name
    • getVpdnGroupByName

      public VpdnGroup getVpdnGroupByName(String name)
      Information provided by the PKI file:
      
          \brief Returns the VPDN group with the specified name.
          
          \param name, the name of the VPDN group of interest.
          
          \return VpdnGroup, the VpdnGroup object with the specified name.
          
              
      Specified by:
      getVpdnGroupByName in interface VirtualTemplateManager
      Parameters:
      name - Takes in a parameter of name
      Returns:
      VpdnGroup Returns a VpdnGroup
    • getVpdnGroupCount

      public int getVpdnGroupCount()
      Information provided by the PKI file:
      
          \brief Returns the number of VPDN groups.
          
          \param int, the number of VPDN groups.
          
              
      Specified by:
      getVpdnGroupCount in interface VirtualTemplateManager
      Returns:
      int Returns a int
    • getVpdnGroupAt

      public VpdnGroup getVpdnGroupAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the VPDN group at the specified name.
          
          \param index, the index of the VPDN group of interest.
          
          \return VpdnGroup, the VpdnGroup object at the specified name.
          
              
      Specified by:
      getVpdnGroupAt in interface VirtualTemplateManager
      Parameters:
      index - Takes in a parameter of index
      Returns:
      VpdnGroup Returns a VpdnGroup
    • setVpdnEnable

      public void setVpdnEnable(boolean flag)
      Information provided by the PKI file:
      
          \brief Enables or disables VPDN.
          
          \param flag, true to enable VPDN, false to disable it.
          
              
      Specified by:
      setVpdnEnable in interface VirtualTemplateManager
      Parameters:
      flag - Takes in a parameter of flag
    • isVpdnEnable

      public boolean isVpdnEnable()
      Information provided by the PKI file:
      
          \brief Returns true if VPDN is enabled, otherwise false.
          
          \return bool, true if VPDN is enabled, otherwise false.
          
              
      Specified by:
      isVpdnEnable in interface VirtualTemplateManager
      Returns:
      boolean Returns a boolean